docs: fix broken SearchCriteria reference link#77
Merged
Conversation
The FILTER-SEARCH-RESULTS.md file referenced a non-existent SEARCH-CRITERIA.md document. The SearchCriteria documentation exists in LIBRARY-API.md with comprehensive coverage of construction, builder methods, fields, and examples. Updated the link to point to the correct section anchor. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
zircote
added
automation
documentation
Contributor
Benchmark ResultsNo benchmarks configured. Add benchmarks to benches/ directory. Full results available in CI artifacts. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #77 +/- ##
=======================================
Coverage 95.83% 95.83%
=======================================
Files 9 9
Lines 6499 6499
=======================================
Hits 6228 6228
Misses 271 271 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Code Coverage ReportOverall Coverage: 0% SummaryFull HTML report available in CI artifacts. |
There was a problem hiding this comment.
Pull request overview
Fixes a broken internal documentation link in the “How to Filter Search Results” guide by pointing the SearchCriteria reference to the correct section in the library API reference.
Changes:
- Replaced the dead link to
../reference/SEARCH-CRITERIA.mdwith../reference/LIBRARY-API.md#searchcriteria.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixed a broken internal documentation link in the "How to Filter Search Results" guide.
Changes
docs/how-to/FILTER-SEARCH-RESULTS.md../reference/SEARCH-CRITERIA.md../reference/LIBRARY-API.md#searchcriteriaWhy This Matters
The
SearchCriteriadocumentation exists inLIBRARY-API.md(lines 305-369) with comprehensive coverage of:The broken link prevented users from accessing this complete reference material.
Verification
docs/reference/LIBRARY-API.md#searchcriteriaexistsSEARCH-CRITERIA.mdfoundDocumentation Quality
This repository has excellent documentation (17,014 lines across 60+ files) following the Diataxis framework. This was the only broken link found during comprehensive documentation audit.